home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 21 / Cream of the Crop 21 (Terry Blount) (October 1996).iso / os2 / cfgsrt21.zip / CFGSORT.TXT < prev    next >
Text File  |  1996-09-15  |  16KB  |  414 lines
  1.  
  2.                                CONFIGSORT 2.1
  3.  
  4.                        (C)1996 by Philip A. O'Malley
  5.  
  6.  
  7. 1.1 INTRODUCTION
  8.  
  9.     The backbone of an OS/2  system  is  the config.sys file. Unfortunately,
  10. this file starts out as an organizational mess and continually gets worse as
  11. numerous applications modify it.
  12.  
  13.     Enter ConfigSort. :)
  14.  
  15.     ConfigSort will process  config.sys  and  re-organize  it into something
  16. substantially more functional. System entries  are sorted into sections, and
  17. additional entries can be optionally organized into user-defined sections or
  18. incorporated into the default structure.
  19.  
  20.     The difference is quite astounding, as I'm sure you'll agree.
  21.  
  22.  
  23. 1.2 A NOTE ON VERSION 2.0
  24.  
  25.     Version 1.x of ConfigSort was  a  completely self-contained entity, with
  26. all the application sections hardcoded into  the program. With 2.0, the user
  27. now has the option of creating  their  own application entries or change the
  28. ones provided with the distribution via an external configuration file.
  29.  
  30.     With this increased  power  comes  increased  potential  to  disrupt the
  31. smooth  running  of  your  system.  I   would  strongly  suggest  that  this
  32. documentation is read thoroughly before attempting to modify the application
  33. configuration file or, indeed, using the program at all.
  34.  
  35.     I know from the e-mail support  queries  that  I  had with 1.x that some
  36. people (and a bigger  percentage  than  one  would  think reasonable) simply
  37. didn't bother to read the  accompanying  documentation either before running
  38. the program or afterwards when things didn't work.
  39.  
  40.     On your own head be it if *you* don't!
  41.  
  42.  
  43. 2.1 REQUIREMENTS
  44.  
  45.     ConfigSort is a compiled REXX  program.  As  a consequence you must have
  46. REXX installed, which comes as  standard  in  the OS/2 Warp distribution. In
  47. addition, ConfigSort also uses  the  RXEXTRAS.DLL  library  and this must be
  48. present within the LIBPATH: "/OS2/DLL" is usually a good place.
  49.  
  50.     RXEXTRAS.DLL is included in the ConfigSort distribution.
  51.  
  52.  
  53. 2.2 LICENCE FOR USE
  54.  
  55.     ConfigSort is an original program, copyrighted to the author. It may not
  56. be modified in any shape  or  form.  It  can be freely distributed providing
  57. that no charge is made beyond those  to cover duplication costs and that the
  58. original distribution archive remains unaltered.
  59.  
  60.     ConfigSort is provided "as  is"  and  any  damage,  actual or perceived,
  61. caused by the program is not the  liability  of  the author. Your use of the
  62. program signifies your acceptance of these conditions.
  63.  
  64.     If you have no problems with the above, then onwards... :)
  65.  
  66.  
  67. 3.1 INSTALLATION
  68.  
  69.     1. Create a directory, eg. /CFGSORT, and place the main program files in
  70.        there. These are CFGSORT.EXE, CFGSORT.APP and CFGSORT.CLI.
  71.  
  72.     2. Copy RXEXTRAS.DLL, found in  the  "/DLL"  directory  created when the
  73.        distribution archive was unarchived, to the LIBPATH. If in doubt copy
  74.        it to "/OS2/DLL" on the boot partition.
  75.  
  76.     3. Edit CONFIG.SYS on the boot drive and add the following line:
  77.  
  78.          SET CONFIGSORT=<path to the directory containing the program files>
  79.  
  80.        For example,
  81.  
  82.          SET CONFIGSORT=H:/CFGSORT
  83.  
  84.     4. Reboot the machine.
  85.  
  86.  
  87. 3.2 USAGE AND SYNTAX
  88.  
  89.     ConfigSort is command-line driven. All options are invoked, or prefixed,
  90. by keywords and are:
  91.  
  92.  1. /IN <FQFN>
  93.  
  94.     This specifies the fully-qualified filename of the config.sys file to be
  95.     processed. This is the only required keyword.
  96.  
  97.  2. /OUT <FQFN>
  98.  
  99.     This specifies an output file for ConfigSort to write to.
  100.  
  101.     If this keyword is not specified then the original /IN file is backed-up
  102.     with a .bak extension and then overwritten.
  103.  
  104.  3. /APPCFG <FQFN>
  105.  
  106.     This  specifies   a   fully-qualified   filename   for   the  ConfigSort
  107.     applications configuration file.
  108.  
  109.  4. /NOAPPS
  110.  
  111.     By default, multiple entries made by  an  application are grouped into a
  112.     section at the end of the file. This keyword disables this facility.
  113.  
  114.  5. /NOSORT
  115.  
  116.     By default, all SET statements  are  sorted into descending alphabetical
  117.     order. This keyword disables this facility.
  118.  
  119.  6. /NOUPPER
  120.  
  121.     By default, all lines in the  processed file are turned upper-case, with
  122.     the exception of the information  associated with SET statements.  This
  123.     keyword disables this facility.
  124.  
  125.  
  126. 3.3 EXAMPLES
  127.  
  128.     This section is just intended  to  visualise  the above into something a
  129. little more tangible. Three examples of syntax are shown below:
  130.  
  131.  1. PROCESS "F:\CONFIG.SYS" (AND BACKUP TO F:\CONFIG.BAK)
  132.  
  133.     cfgsort /in f:\config.sys
  134.  
  135.  2. PROCESS "F:\CONFIG.SYS" AND OUTPUT TO "F:\CONFIG.NEW"
  136.  
  137.     cfgsort /in f:\config.sys /out f:\config.new
  138.  
  139.  3. PROCESS "F:\CONFIG.SYS" WITH ALL OPTIONS OFF
  140.  
  141.     cfgsort /in f:\config.sys /noapps /nosort /noupper
  142.  
  143.  
  144. 4.1 EXTERNAL CONFIGURATION FILES
  145.  
  146.     Unlike v1.x, ConfigSort 2.0 and above allows you to optionally configure
  147. how the program behaves upon  execution.  There  are  two files which may be
  148. used for this purpose:
  149.  
  150.  1. CFGSORT.CLI
  151.  
  152.     This file may contain any number  of  command-line options which will be
  153.     executed when the program runs. Thus it is perfectly possible to set the
  154.     file up so that a standard  configuration  is processed and saved, using
  155.     various options, by just invoking the cfgsort.exe program itself.
  156.  
  157.     As a enhancement to it's usefulness, any conflicting command-line option
  158.     specified manually when invoking the  program  will take presidence over
  159.     any similar option detailed in the  file.  Thus, an /IN statement in the
  160.     cfgsort.cli can be overriden by an /IN statement manually specified.
  161.  
  162.     This file  should  reside  in  the  directory  which  the  environmental
  163.     variable CONFIGSORT points to (see 3.1).  There  is no way to specify an
  164.     optional location for this file as it would somewhat negate the point of
  165.     saving typing time. ;)
  166.  
  167.     An example of a CFGSORT.CLI file might be:
  168.  
  169.       /IN F:\CONFIG.SYS
  170.       /NOUPPER
  171.       /NOSORT
  172.  
  173.     The above example would this process a config.sys file which sits in the
  174.     root directory of F:\  and  rename  it  to  config.bak (see 3.2(2)). The
  175.     optional switches /NOUPPER and /NOSORT are active.
  176.  
  177.  2. CFGSORT.APP
  178.  
  179.     This is the configuration file for  the applications sorting. It usually
  180.     resides in the  directory  referenced  by  the  CONFIGSORT environmental
  181.     variable (see 3.1), but can  be  optionally  specified using the /APPCFG
  182.     keyword (see 3.2(3)) on the command-line.   It is obviously necessary if
  183.     applications sorting is active,  ie.  when  the  /NOAPPS  keyword is not
  184.     specified on the command-line.
  185.  
  186.     Each application section is begun with  a "SECTION" keyword, followed by
  187.     a *single* word identifying the application.
  188.  
  189.       eg. SECTION EXT2
  190.  
  191.     A section is not terminated  by  a  specific keyword, but if effectively
  192.     ended when a new "SECTION" keyword is specified.
  193.  
  194.     The "SECTION" keyword is followed, on  a separate line, by four optional
  195.     prefix keywords, "DESC", "SET",  "FILE" and "PATH":
  196.  
  197.       1. DESC
  198.  
  199.          This  keyword  allows  you  to   specify   an  identifier  for  the
  200.          application section to be used in the processed config.sys. If this
  201.          is not specified then ConfigSort  will use the identifier specified
  202.          with the "SECTION" keyword.
  203.  
  204.            eg. DESC EXT2FS LINUX FILE-SYSTEM
  205.  
  206.       2. SET
  207.  
  208.          This keyword allows you  to  specify  which  SET  statements in the
  209.          config.sys file  will  be  grouped  into  the  current  application
  210.          section. Multiple statements  may  be  included  on  the same line,
  211.          provided that they  are  separated  by  a  space,  or  multiple SET
  212.          keywords may be used for each individual entry.
  213.  
  214.            eg. SET ETC TEMP LANG
  215.  
  216.                or
  217.  
  218.            eg. SET ETC
  219.                SET TEMP
  220.                SET LANG
  221.  
  222.          Notice that SET statements which contain  spaces can be included by
  223.          substituting an exclamation-mark for